N4 Provides 2 Web Services for paid-thru date.
Update paid-thru date for storage charges which updates both unit model and shared extract table
Propose paid-thru date for storage or reefer power which is used for return information only
Both APIs take the same input parameters:
Request parameters are:
scopeCoordinateIdsWsType
eqId- Container Number
chargeFor- STORAGE or REEFER
paidThruDay
extract gkey
API WSDL
<xsd:element name="updatePaidThruDay">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="scopeCoordinateIdsWsType"type="types:ScopeCoordinateIdsWsType"/>
<xsd:element minOccurs="1"name="eqId"type="xsd:string"/>
<xsd:element minOccurs="1"name="chargeFor"type="xsd:string"/>
<xsd:element minOccurs="1"name="paidThruDay"type="xsd:string"/>
<xsd:element minOccurs="1"name="extractGkey"type="xsd:long"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="updatePaidThruDayResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="updatePaidThruDayResponse"type="types:UpdatePaidThruDayResponseWsType"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<!-- Propose anewpaid thru dayforSTORAGE or REEFER POWER. ptdDate DATE_TIME_FORMAT ="yyyy-MM-dd HH:mm:ss" -->
In the case where a container has two unpaid storage periods:
Storage period 1: Export container A gate-in to terminal. Afterward shipper requests to dray off for re-stuffing. Export container gate out from terminal.
Storage period 2: After re-stuffing, Export container A re-enter to terminal with outbound shipment remaining the same.
The paid-thru date will apply to the storage period of the correct storage time span. In the case of overlapping storage dates (out and in in the same day), the paid-thru date refers to the earlier storage span.
The API will return:
first free day, last free day
out time
previous paid-thru date
proposed paid-thru date
computed paid-thru date
free days
days paid
days owed
period array
API WSDL
<xsd:element name="proposePaidThruDay">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="scopeCoordinateIdsWsType"type="types:ScopeCoordinateIdsWsType"/>
<xsd:element minOccurs="1"name="eqId"type="xsd:string"/>
<xsd:element minOccurs="1"name="chargeFor"type="xsd:string"/>
<xsd:element minOccurs="1"name="paidThruDay"type="xsd:date"/>
<xsd:element minOccurs="1"name="extractGkey"type="xsd:long"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="proposePaidThruDayResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="proposePaidThruDayResponse"type="types:ProposePaidThruDayResponseWsType"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>